Skip to content

docs: realign autodoc screenshots with the redesigned file explorer - #15

Merged
Xander-git merged 1 commit into
mainfrom
claude/exciting-mirzakhani-79355e
May 20, 2026
Merged

docs: realign autodoc screenshots with the redesigned file explorer#15
Xander-git merged 1 commit into
mainfrom
claude/exciting-mirzakhani-79355e

Conversation

@Xander-git

Copy link
Copy Markdown
Collaborator

Summary

  • Realigns the Playwright screenshot autodoc pipeline (scripts/generate_screenshots.py) and the Sphinx user guide with the redesigned three-region file explorer — the old pipeline still documented the retired two-tab layout (dead tab-details testid) and only ever captured the explorer's empty state.
  • Reorders the user guide to the operator journey (Getting Started → Settings → Browse → creation wizards → README → Orchestrator → Problems), renumbering pages so the filename prefix is the reading order rather than the design-spec capability number.
  • Rewrites the browse page for the three-region explorer, adds a Getting Started page and an Add-Equipment section, drops two orphaned screenshot capabilities (09/10), and regenerates the committed screenshots.

Test plan

  • generate_screenshots.py captures all 9 capabilities (OK)
  • sphinx -W -b html builds with zero warnings
  • Populated file-explorer screenshot verified visually (tree + file list + metadata pane + breadcrumb)
  • All {doc} cross-references and {image} paths resolve
  • CI docs workflow passes

🤖 Generated with Claude Code

The Playwright screenshot script and the Sphinx user guide had drifted
after the GUI redesign re-wired /main to the three-region file explorer:
the browse page documented the retired two-tab layout, the script only
ever captured the explorer's empty state, and two capabilities produced
screenshots no page embedded.

- generate_screenshots.py: nine journey-ordered capabilities; capture
  the populated explorer (?selected=) and the Add-Equipment wizard; drop
  the orphaned 09/10 capabilities
- reorder the guide to the operator journey (setup -> file explorer ->
  creation -> monitoring) and renumber pages so the prefix is the
  reading order
- rewrite the browse page for the three-region explorer; add a Getting
  Started page and an Add-Equipment section to the Settings page
- regenerate the committed screenshots; drop six stale folders

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@Xander-git
Xander-git merged commit ca68bdb into main May 20, 2026
8 checks passed
@Xander-git
Xander-git deleted the claude/exciting-mirzakhani-79355e branch May 20, 2026 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant